stop getPlatformProxy crashing with internal DOs #8697

emily-shen · 2025-03-27T11:17:58Z

this sets the name of the getPlatformProxy 'worker' to the provided worker name, so miniflare stops crashing when the proxy DO worker tries to bind to it.

Internal DOs still don't work, but at least it doesn't crash now? And it has a be

Fixes #8687

Tests
- TODO (before merge)
- Tests included
- Tests not necessary because:
Wrangler E2E Tests CI Job required? (Use "e2e" label or ask maintainer to run separately)
- I don't know
- Required
- Not required because:
Public documentation
- TODO (before merge)
- Cloudflare docs PR(s): Explain how to do local dev when you have DOs with a framework cloudflare-docs#21198
- Documentation not necessary because: bug fix
Wrangler V3 Backport
- TODO (before merge)
- Wrangler PR: V3 Backport #8697: prevent getPlatformProxy from crashing with internal DOs #8713
- Not necessary because:

changeset-bot · 2025-03-27T11:18:03Z

🦋 Changeset detected

Latest commit: e9636eb

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
wrangler	Patch
@cloudflare/vitest-pool-workers	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

github-actions · 2025-03-27T11:25:11Z

A wrangler prerelease is available for testing. You can install this latest build in your project with:

npm install --save-dev https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/14174103654/npm-package-wrangler-8697

You can reference the automatically updated head of this PR with:

npm install --save-dev https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/prs/8697/npm-package-wrangler-8697

Or you can use npx with this latest build directly:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/14174103654/npm-package-wrangler-8697 dev path/to/script.js

Additional artifacts:

cloudflare-workers-bindings-extension:

wget https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/14174103654/npm-package-cloudflare-workers-bindings-extension-8697 -O ./cloudflare-workers-bindings-extension.0.0.0-vb21be6f24.vsix && code --install-extension ./cloudflare-workers-bindings-extension.0.0.0-vb21be6f24.vsix

create-cloudflare:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/14174103654/npm-package-create-cloudflare-8697 --no-auto-update

@cloudflare/kv-asset-handler:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/14174103654/npm-package-cloudflare-kv-asset-handler-8697

miniflare:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/14174103654/npm-package-miniflare-8697

@cloudflare/pages-shared:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/14174103654/npm-package-cloudflare-pages-shared-8697

@cloudflare/unenv-preset:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/14174103654/npm-package-cloudflare-unenv-preset-8697

@cloudflare/vite-plugin:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/14174103654/npm-package-cloudflare-vite-plugin-8697

@cloudflare/vitest-pool-workers:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/14174103654/npm-package-cloudflare-vitest-pool-workers-8697

@cloudflare/workers-editor-shared:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/14174103654/npm-package-cloudflare-workers-editor-shared-8697

@cloudflare/workers-shared:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/14174103654/npm-package-cloudflare-workers-shared-8697

@cloudflare/workflows-shared:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/14174103654/npm-package-cloudflare-workflows-shared-8697

Note that these links will no longer work once the GitHub Actions artifact expires.

[email protected] includes the following runtime dependencies:

Package	Constraint	Resolved
`miniflare`	workspace:*	4.20250321.1
`workerd`	1.20250321.0	1.20250321.0
`workerd --version`	1.20250321.0	2025-03-21

Please ensure constraints are pinned, and miniflare/workerd minor versions match.

fixtures/get-platform-proxy/tests/get-platform-proxy.env.test.ts

fixtures/get-platform-proxy/wrangler_external_do.jsonc

vicb · 2025-03-27T14:42:54Z

packages/wrangler/src/api/integrations/platform/index.ts

+				${localBindings.map((b) => `- ${JSON.stringify(b)}`).join("\n")}
+				These will not work in local development, but they should work in production.
+
+				If you want to develop these locally, you can define your DO "externally" in another worker.


Defining a DO "in a worker" is confusing (at least to me)

Suggested change

If you want to develop these locally, you can define your DO "externally" in another worker.

If you want to develop these locally, you can define your DO "externally" in another wrangler configuration.

How about 👇

If you want to develop these locally, you can define your DO in a separate Worker, specified by a separate configuration file.

tho it is not clear what the recommended thing to do would be when multiple DOs are defined. I'm assuming each DO in a separate Worker?

fixtures/get-platform-proxy/wrangler_external_do.jsonc

packages/wrangler/src/deployment-bundle/entry.ts

dario-piotrowicz

Looks good to me 😄

emily-shen · 2025-03-27T16:19:42Z

nvm the warning message is getting ridiculously long - i'm going to create a section in the docs to link to

dario-piotrowicz · 2025-03-27T17:08:36Z

nvm the warning message is getting ridiculously long - i'm going to create a section in the docs to link to

There's already some content for the DO issue here: https://developers.cloudflare.com/workers/wrangler/api/#supported-bindings 🙂

emily-shen · 2025-03-27T17:26:42Z

docs PR:
cloudflare/cloudflare-docs#21198

(sorry @dario-piotrowicz I didn't see your comment until after I finished 😅 )

vicb

Thanks a lot for fixing this @emily-shen 🙏

CarmenPopoviciu · 2025-03-28T16:47:28Z

pending docs review and landing first, since this PR references the newly added section

CarmenPopoviciu · 2025-03-31T13:11:11Z

docs PR was merged. This is no longer blocked and I will proceed to merge it

…rnal DOs (#8713) * pass name to getplatformproxy * fixup * remove out of date warning * stop gpp crashing with internal DOs * changeset * fix e2e * pr feedback * elaborate on error message * move to a docs link * fix failing test * copy improvement * fix * update docs link * update link --------- Co-authored-by: emily-shen <[email protected]>

workers-devprod added this to workers-sdk Mar 27, 2025

github-project-automation bot moved this to Untriaged in workers-sdk Mar 27, 2025

emily-shen marked this pull request as ready for review March 27, 2025 14:04

emily-shen requested a review from a team as a code owner March 27, 2025 14:04

emily-shen added the e2e Run wrangler + vite-plugin e2e tests on a PR label Mar 27, 2025

vicb reviewed Mar 27, 2025

View reviewed changes

fixtures/get-platform-proxy/tests/get-platform-proxy.env.test.ts Outdated Show resolved Hide resolved

vicb reviewed Mar 27, 2025

View reviewed changes

fixtures/get-platform-proxy/wrangler_external_do.jsonc Outdated Show resolved Hide resolved

vicb reviewed Mar 27, 2025

View reviewed changes

fixtures/get-platform-proxy/wrangler_external_do.jsonc Show resolved Hide resolved

vicb reviewed Mar 27, 2025

View reviewed changes

packages/wrangler/src/deployment-bundle/entry.ts Show resolved Hide resolved

dario-piotrowicz approved these changes Mar 27, 2025

View reviewed changes

github-project-automation bot moved this from Untriaged to Approved in workers-sdk Mar 27, 2025

emily-shen force-pushed the emily/DO branch from cc47c4e to 74d95fd Compare March 27, 2025 15:57

vicb approved these changes Mar 27, 2025

View reviewed changes

CarmenPopoviciu force-pushed the emily/DO branch from 01078de to 950fbfc Compare March 28, 2025 11:08

vicb mentioned this pull request Mar 28, 2025

[BUG] Build Fails Due to Missing Durable Object Classes in Worker Configuration opennextjs/opennextjs-cloudflare#502

Closed

emily-shen added 9 commits March 28, 2025 12:57

pass name to getplatformproxy

4b2f4d6

fixup

e3b5485

remove out of date warning

1ad6c6b

stop gpp crashing with internal DOs

e8580ed

changeset

77c92fa

fix e2e

8be466f

pr feedback

8992703

elaborate on error message

e96f022

move to a docs link

ed51d04

CarmenPopoviciu added 2 commits March 28, 2025 12:57

fix failing test

e5ff82f

copy improvement

d32ae37

CarmenPopoviciu force-pushed the emily/DO branch from 950fbfc to d32ae37 Compare March 28, 2025 11:57

CarmenPopoviciu mentioned this pull request Mar 28, 2025

V3 Backport #8697: prevent getPlatformProxy from crashing with internal DOs #8713

Merged

update docs link

a7e4149

CarmenPopoviciu added the blocked Blocked on other work label Mar 28, 2025

update link

c5a973d

CarmenPopoviciu removed the blocked Blocked on other work label Mar 31, 2025

CarmenPopoviciu approved these changes Mar 31, 2025

View reviewed changes

Merge branch 'main' into emily/DO

e9636eb

CarmenPopoviciu merged commit ec1f813 into main Mar 31, 2025
20 of 21 checks passed

CarmenPopoviciu deleted the emily/DO branch March 31, 2025 15:19

github-project-automation bot moved this from Approved to Done in workers-sdk Mar 31, 2025

workers-devprod mentioned this pull request Mar 31, 2025

Version Packages #8730

Merged

	If you want to develop these locally, you can define your DO "externally" in another worker.
	If you want to develop these locally, you can define your DO "externally" in another wrangler configuration.

stop getPlatformProxy crashing with internal DOs #8697

stop getPlatformProxy crashing with internal DOs #8697

Uh oh!

Conversation

emily-shen commented Mar 27, 2025 • edited by CarmenPopoviciu Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-bot bot commented Mar 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

github-actions bot commented Mar 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vicb Mar 27, 2025

Choose a reason for hiding this comment

Uh oh!

CarmenPopoviciu Mar 28, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

dario-piotrowicz left a comment

Choose a reason for hiding this comment

Uh oh!

emily-shen commented Mar 27, 2025

Uh oh!

dario-piotrowicz commented Mar 27, 2025

Uh oh!

emily-shen commented Mar 27, 2025

Uh oh!

vicb left a comment

Choose a reason for hiding this comment

Uh oh!

CarmenPopoviciu commented Mar 28, 2025

Uh oh!

CarmenPopoviciu commented Mar 31, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

emily-shen commented Mar 27, 2025 •

edited by CarmenPopoviciu

Loading

changeset-bot bot commented Mar 27, 2025 •

edited

Loading

github-actions bot commented Mar 27, 2025 •

edited

Loading